home *** CD-ROM | disk | FTP | other *** search
/ Aminet 23 / Aminet 23 (1998)(GTI - Schatztruhe)[!][Feb 1998].iso / Aminet / docs / hyper / aosguide.lha / Guide (.txt) < prev    next >
Amigaguide Document  |  1996-01-24  |  9KB  |  252 lines
  1. @database Guide
  2. @author Thorsten Willert
  3. @(c) "Copyright 
  4.  1994-96 by Thorsten Willert"
  5. @$VER: Guide       V0.83 (26.01.96)
  6. @Index AmigaOSGuide_Index/Main
  7. @Help AmigaOSGuide_Hilfe/Lexikon
  8. ^^ -------------------------------------------------------------
  9. @node MAIN "AmigaOSGuide Lexikon:  AmigaGuide
  10. -Hypertext-Erstellung"
  11. @prev Lexikon-ABC/AmigaGuide
  12. @toc Lexikon-ABC/AmigaGuide
  13.         @{" Allgemeines        " link Allgemeines}
  14.         @{" Allgemeine Befehle " link Allgemeine}
  15.         @{" Node Befehle       " link Nodes}
  16.         @{" Gadgets            " link Gadgets}
  17.         @{" Textattribute      " link Text} @{fg shine}
  18. @endnode
  19. ^^ -----------------------------------------------------------------------------
  20. @node Allgemeines "AmigaOSGuide Lexikon:  AmigaGuide
  21. -Hypertext-Erstellung"
  22.      Die hier Beschriebene Programmierung bezieht sich nur auf AmigaGuide
  23.      ab Version 39 (MultiView)! @{fg shine}
  24.      _____________________________________________________________________
  25. @{fg text}
  26.      Die Datei mu
  27.  im ASCII-Format erstellt werden, wie z.B. @{" Ed " link DOS-EFGH/ED}.
  28.      Der 
  29. Klammeraffe @
  30.  (ALT-2) leitet immer eine Steuersequence ein,
  31.      dies erm
  32. glicht die Eingabe von Trennlinien oder Kommentaren, zwi-
  33.      schen den einzelnen NODES (Marken), zur besseren Orientierung bei
  34.      der 
  35. Programmierung
  36.      S
  37. mtliche Befehle m
  38. ssen immer ganz Links stehen, au
  39. er sie stellen
  40.      @{" Gadgets " link Gadgets} dar oder sind @{" Textattribute " link Text}.
  41.      Im Text selber kann das 
  42. -Zeichen 
  43. berhaupt nicht und \\ nur dar-
  44.      gestellt werden wenn ihm wiederrum ein \\ vorransteht.
  45.      Befehle selber k
  46. nnen ebenfalls mit einem vorrangestellten \\ sicht-
  47.      bar gemacht werden, verlieren dann aber ihre Funktion.@{fg shine}
  48.      _____________________________________________________________________
  49. @{fg text} @{b}
  50.      * Tip zur Programmierung: *@{ub}
  51.      Erstmal den Text schreiben (auch Men
  52. s) und @{b}dann@{ub} erst die
  53.      Steuerzeichen eingeben, sonst kriegt man b
  54. se Formatierungsprobleme!
  55.      Viel Spa
  56. @endnode
  57. ^^ ------------------------------------------------------------------------------
  58. @node Allgemeine "AmigaGuide
  59. -Programmierung:  Allgemeine Befehle"
  60. @{fg shine}
  61.      _____________________________________________________________________
  62. @{fg text} @{b}
  63.      \@Database <Name>@{ub}
  64.      Mu
  65.  immer am @{b}Anfang@{ub} eines AmigaGuide
  66.  Dokumentes stehen!
  67.      @{b}Sonst wird es nicht als Guide erkannt!
  68.      \@$VER: <AmigaDOS-Versionsbezeichnung>@{ub}
  69.      Gibt auf den Befehl @{" Version " link DOS-UVWXYZ/Version} die Versionsnummer der Guide-
  70.      Datei aus.
  71.      \@Author <Name> @{ub}
  72.      Bezeichnet den Autor an.
  73.      \@<Copyright> @{ub}
  74.      Gibt das Copyright an.
  75.      \@Master <Datei> @{ub}
  76.      Bezeichnet die 
  77. Quelldatei
  78.      \@Font <Name> <Gr
  79. e>@{ub}
  80.      Name und Gr
  81. r den Zeichensatz, der in dem Guide verwendet
  82.      werden soll.
  83.      \@Index <Node> oder <Datei/Node>@{ub}
  84.      Aktiviert das @{" Index " beep} Symbol und bezeichnet die Indexmarke.
  85.      \@Help <Node> oder <Datei/Node>@{ub}
  86.      Aktiviert @{" Hilfe " beep} Symbol und gibt wiederum die Sprungmarke an.
  87.      Wird @Help nicht gesetzt erscheint bei Aufruf von Hilfe das
  88.      HelpGuide (amigaguide.gudie), das sich im Verzeichnis Sys:Locale/
  89.      Help/Deutsch/Sys befindet
  90.      \@WordWrap @{ub}
  91.      Aktiviert den Wortumbruch. D.h.: Passt ein Wort nicht mehr in das
  92.      sichtbare Fenster, wird es in die n
  93. chste Zeile geschrieben.
  94.      Ist nur sinnvoll, wenn man bei der Erstellung des Guides darauf
  95.      achtet, da
  96.  jeder Satz m
  97. glichst in eine Zeile pa
  98. t, und man
  99.      keinen linken Rand l
  100. t! Sonst wird das Ergebnis unleserlich.
  101.      \@Remark <Text> @{ub}
  102.      Kommentar, der im Guide selber nicht sichtbar ist. @{fg shine}
  103.      ___________________________________________________________________
  104. @{fg text}
  105. @endnode
  106. ^^ -----------------------------------------------------------------------------
  107. @node Nodes "AmigaGuide
  108. -Programmierung:  Node Befehle"
  109. @{fg shine}
  110.      _____________________________________________________________________
  111. @{fg text} @{b}
  112.      \@Node <Name> <Titel>@{ub}
  113.      Beginn eines neuen Abschnittes.
  114.      Wobei der Abschnittsname die Sprungmarke ist, zu der Verzweigt
  115.      wird und die 
  116. berschrift den Text in der Titelleiste angibt. Wird
  117.      diese weggelassen entspricht die 
  118. berschrift der Sprungmarke.
  119.      Anf
  120. hrungszeichen k
  121. nnen bei den <Namen> und <Titel> zur besseren
  122.      
  123. bersicht eingeben werden. Sind aber nur erforderlich, wenn sie
  124.      unterschiedlich sind.
  125.      Die Hauptseite (@{" Inhalt " beep}) mu
  126.  folgendes Format haben:
  127.      \@Node Main <Titel>
  128.      Innerhalb@{ub} eines Abschnittes k
  129. nnen folgende Befehle verwendet
  130.      werden:
  131.        \@toc <Node>@{ub}
  132.        Gibt den Abschnitt an, indem f
  133. r den angezeigten, der @{" Inhalt " beep}
  134.        steht.
  135.        \@Keywords <Namen> @{ub}
  136.        Assignments f
  137. r diesen Node, wird benutzt, wenn nach einem Node
  138.        gesucht wird.
  139.        \@Font <Name> <Gr
  140. e>@{ub}
  141.        Name und Gr
  142. r den Zeichensatz, der in der Node verwendet
  143.        werden soll.
  144.        \@prev <Node>@{ub}
  145.        Gibt den Abschnitt an, zu dem mit @{" Bl
  146. ttern < " beep} verzweigt wird.
  147.        \@next <Node>@{ub}
  148.        Gibt den Abschnitt an, zu dem mit @{" Bl
  149. ttern > " beep} verzweigt wird.
  150.      \@endnode@ <Name>@{ub}
  151.      Ende eines Abschnittes. Der <Name> kann zu besseren 
  152. bersicht ein-
  153.      gegeben werden. Ist aber nicht erforderlich. @{fg shine}
  154.      ___________________________________________________________________
  155. @{fg text}
  156. @endnode
  157. ^^ -----------------------------------------------------------------------------
  158. @node Gadgets "AmigaGuide
  159. -Programmierung:  Gadgets"
  160. @{fg shine}
  161.      _____________________________________________________________________
  162. @{fg text} @{b}
  163.      Gadgets mit ihren Funktionen haben folgendes Format:
  164.        \@{"  <Bezeichnung>  " <Befehl>}
  165.        <Bezeichnung>@{ub}
  166.        Das was auf dem @{" Gadget " beep} steht. Die Abst
  167. nde der Anf
  168. hrungszei-
  169.        chen von Bezeichnung bestimmen die @{"     Gr
  170. e     " beep} des Gadgets
  171.        Diese k
  172. nnen nat
  173. rlich 
  174. irgendwo
  175.  im Text stehen.
  176.      Folgende <Befehle> sind m
  177. glich:
  178.        LINK <Node> oder <Datei/Node #>@{ub}
  179.        Zeigt den angegebenen Abschnitt innerhalb dieser Datei <Node>
  180.        oder den entsprechenden Abschnitt einer anderen Guide-Datei
  181.        <Datei/Node>, wobei # die Nummer der Zeile angibt zu der in
  182.        dem Abschnitt verzweigt werden soll. Die Zeilen werden ab
  183.        \@node <Name> gez
  184. hlt. Bei keiner Angabe einer Nummer wird zu
  185.        dem Anfang des Guides verzweigt (Zeile 0).
  186.        RX <ARexx-Script>@{ub}
  187.        F
  188. hrt das angegeben ARexx-Script aus.
  189.        RXS <ARexx-Befehl>@{ub}
  190.        F
  191. hrt einen ARexx-Befehl direkt aus.
  192.        SYSTEM <Befehl>@{ub}
  193.        F
  194. hrt den angegeben DOS-Befehl aus.
  195.        QUIT@{ub}
  196.        Beenden von AmigaGuide.
  197.        Bei MultiView wird allerdings das dazugeh
  198. rige Fenster nicht ge-
  199.        schlossen!
  200.        BEEP @{ub}
  201.        Gibt das aus was man im Preferences-Editor-SOUND, eingestellt hat.
  202.        -> @{" Test " Beep}
  203. @{fg shine}
  204.      _____________________________________________________________________
  205. @{fg text}
  206. @endnode
  207. ^^ -----------------------------------------------------------------------------
  208. @node Text "AmigaGuide
  209. -Programmierung:  Textattribute"
  210. @{fg shine}
  211.      _____________________________________________________________________
  212. @{fg text}
  213.      Diese k
  214. nnen 
  215. irgendwo
  216.  im Text stehen.
  217.   @{b}     \@{b}@{ub}   aktiviert @{b}Fettdruck@{ub}
  218.   @{b}     \@{ub}@{ub}  inaktivert Fettdruck
  219.   @{b}     \@{i}@{ub}   aktiviert @{i}Schr
  220. gschrift@{ui}
  221.   @{b}     \@{ui}@{ub}  inaktiviert Schr
  222. gschrift @{b}
  223. @{ub}
  224.   @{b}     \@{u}@{ub}   aktiviert @{u}Unterstreichen@{uu}
  225.   @{b}     \@{uu}@{ub}  inaktiviert Unterstreichen
  226.   @{b}     \@{fg <Farbe>}
  227.      Wobei f
  228. r <Farbe> folgende Angaben m
  229. glich sind:@{ub}
  230.        @{fg text}text@{fg text}
  231.        @{fg shine}shine@{fg text}
  232.        @{fg shadow}shadow@{fg text}
  233.        @{fg fill}fill@{fg text}
  234.        @{fg filltext}filltext@{fg text}
  235.        @{fg back}@{bg text}background@{fg text}@{bg back}
  236.        @{fg highlight}highlight @{fg shine}
  237.      _____________________________________________________________________
  238. @{fg text}
  239.      S
  240. mtliche Attribute k
  241. nnen @{fg shine}@{b}@{i}@{u}kombiniert@{fg text}@{ub}@{ui}@{uu} werden !!!.
  242.      @{b}
  243. @{ub} Bei Schr
  244. gschrift darauf achten, da
  245.  @{b}nach@{ub} dem schr
  246. ggestellten Wort
  247.        und dem Befehl \@{ui} ein Leerschritt gemacht wird, sonst passiert
  248.        evtl. folgendes:        @{i}AB@{ui} usw.
  249.        jetzt mit Leerzeichen:  @{i}AB @{ui}usw.
  250. @next Allgemeine
  251. @endnode
  252.